/*
 * Copyright 2002-2005 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.springframework.richclient.core;

import org.springframework.richclient.security.SecurityController;

/**
 * Interface implemented by objects whose authorized state can be controlled by a 
 * {@link SecurityController}. Any object that implements this interface and is processed by
 * {@link org.springframework.richclient.application.config.ApplicationObjectConfigurer#configure(Object, String)}
 * will be linked to the security controller with the id returned by
 * {@link #getSecurityControllerId()}
 * 
 * @author Larry Streepy
 * @see org.springframework.richclient.security.SecurityController
 * @see org.springframework.richclient.application.config.ApplicationObjectConfigurer#configure(Object, String)
 */
public interface SecurityControllable extends Authorizable {

    /**
     * Set the Id of the security controller that should manage this object.
     * @param controllerId Id (bean name) of the security controller
     */
    public void setSecurityControllerId(String controllerId);

    /**
     * Get the id (bean name) of the security controller that should manage this object.
     * @return controller id
     */
    public String getSecurityControllerId();
    
}
